/*
 * This file is part of the Sx Framework Library.
 * 
 * Copyright (C) 2013 University of Colorado Denver
 * <min.choi@ucdenver.edu> <shane.transue@ucdenver.edu>
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy 
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 
 * copies of the Software, and to permit persons to whom the Software is 
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in 
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
 * DEALINGS IN THE SOFTWARE.
 */
#ifndef SX_INTEGER_H
#define SX_INTEGER_H

#include <ostream>

namespace Sx {

/*
 * The Integer class provides a set of utility functions that are commonly
 * useful in the context of a complete library. This class provides a localized
 * library of conversion and parsing functions for basic integering point types.
 */
class Integer {
public:
	Integer();
	Integer(const Integer& i);

	/* Value Constructors */
	Integer(float value);
	Integer(short value);
	Integer(int value);
	Integer(long value);

	~Integer();

	/*
	 * Sets the value of this integer to the provided value.
	 */
	void set(int value);

	/*
	 * Returns the internal integer value stored in this Integer.
	 */
	int data() const;

	/*
	 * Allows the interal representation of this Integer to be used as a native
	 * integer value.
	 */
	operator int () const;

	/*
	 * Returns the maximum possible integer value.
	 */
	static Integer Max();

	/*
	 * Returns the minimum possible integer value.
	 */
	static Integer Min();

	/*
	 * Returns the symbolic value of infinity for a Integer.
	 */
	static Integer Infinity();

	/* Returns an unsigned long conversion of this integer. */
	static unsigned long ToUnsignedLong(const Integer& i);

	/* Operator Defintions */
	Integer operator + (const Integer& i);
	Integer operator + (int i);
	Integer operator - (const Integer& i);
	Integer operator - (int i);
	Integer operator * (const Integer& i);
	Integer operator * (int i);
	Integer operator / (const Integer& i);
	Integer operator / (int i);
	void operator += (const Integer& i);
	void operator += (int i);
	void operator -= (const Integer& i);
	void operator -= (int i);
	void operator *= (const Integer& i);
	void operator *= (int i);
	void operator /= (const Integer& i);
	void operator /= (int i);
	void operator = (const Integer& i);
	void operator = (int i);

	bool operator == (const Integer& i);
	bool operator != (const Integer& i);
	bool operator == (int i);
	bool operator != (int i);
	bool operator <= (const Integer & i);
	bool operator <= (int i);
	bool operator >= (const Integer & i);
	bool operator >= (int i);
	bool operator < (const Integer & i);
	bool operator < (int i);
	bool operator > (const Integer & i);
	bool operator > (int i);

	/* Global integer addition operator */
	friend Integer operator + (int v, const Integer& i);
	friend Integer operator - (int v, const Integer& i);
	friend Integer operator * (int v, const Integer& i);
	friend Integer operator / (int v, const Integer& i);

	/* Provides basic stream ouput for the value of this Integer. */
	friend std::ostream& operator << (std::ostream& out, const Integer& i);

protected:
	int value;
};

}

#endif
